Инструкция по установке 2.0

В документе рассматриваются действия по установке актуальной версии Sigla Vision (далее указан как SV), основанной на принципах распределенной и управляемой архитектуры при помощи средств Docker. В документе описаны шаги по подготовке и выполнению установки при помощи утилиты администрирования и мониторинга состояния сред и “здоровья” Sigla Vision Monitor (далее указан как SV Monitor).

1. Инсталляция SV Monitor

1.1 Пререквизиты

№
Пререквизит
Как проверить
1
На сервере установки SV Monitor в директории /home должно быть не менее 200 ГБ свободного места на диске
На сервере SV Monitor ввести команду df -h
2
Пользователь, устанавливающий SV Monitor должен иметь root права
Ввести команду [ $(id -u) -eq 0 ] && echo "Root" || echo "Not root"

1.2 Выполнение инсталляции

Ниже перечислены шаги, необходимые для выполнения инсталляции SV Monitor на сервере Linux:
1.2.1 На выделенном под установку сервере Linux создать новую директорию SiglaMonitor в /home и выдать права 777:
sudo mkdir /home/SiglaMonitor
sudo chmod 777 /home/SiglaMonitor
1.2.2 Скачать дистрибутив SV Monitor по предоставленной ссылке S3 на сервер. Если отсутствуют прямые средства для скачивания на сервер, тогда предварительно можно скачать дистрибутив на ПК пользователя, выполняющего инсталляцию.
Для этого выполнив действия:
● Скачать дистрибутив SV Monitor по предоставленной ссылке S3 на ПК
● Открыть командную строку (Win+R и выполнить cmd)
● Перейти в директорию с загруженным дистрибутивом и загрузить его на сервер с помощью команды scp
cd Downloads
scp finekey-operation-all.tar.gz
*SSH_app_username*@*IP_APP_SERVER*:/home/SiglaMonitor/
1.2.3 Перейти на сервер и распаковать дистрибутив в директорию /home/SiglaMonitor командой
tar zxvf finekey-operation-all.tar.gz
tar — утилита для работы с архивами,
z — указывает на то, что архив сжат с использованием gzip,
x — означает "extract" (извлечение), т.е. распаковка архива,
v — "verbose", подробный режим вывода, который показывает список файлов, обрабатываемых во время извлечения,
f — указывает, что далее будет имя файла архива, из которого необходимо извлечь данные.
После распаковки в директории /home/SiglaMonitor должна появиться папка finekey:
1.2.4 Изменить содержимое файла finekey/conf/finekey.yaml:
nano /home/SiglaMonitor/finekey/conf/finekey.yaml
● Изменить путь установки dataRootPath на /home/SiglaMonitor/data;
● Убрать режим комментирования с настроек timezone, bip, fip, components: nginx;
● Изменить timezone на "Europe/Moscow" или другой актуальный для вашего часового пояса;
● Изменить bip на 10.0.14.1/24;
● Изменить fip на 10.0.15.1/24;
● Изменить маппинг портов nginx с 80:8080 на 8081:8080;
Примечание: диапазоны bip и fip изменены (старые значения 10.16.0.1/16 и 10.17.0.1/16) т.к. значения по умолчанию часто пересекаются с адресами VDI, из-за чего после установки Sigla Monitor возникает конфликт ip-адресов. Вследствие чего теряется доступ к серверу установки SV Monitor.
В результате файл finekey.yaml должен выглядеть так: 
finekey.yaml
node:
    ip: localhost       #Node IP
    port: 22            #Node SSH port
    user:               #Node SSH username
    password:           #Node SSH password
dataRootPath: /home/SiglaMonitor/data
repo:
    port: 5000 #Registry Port
    url:       #Registry URL
    username:  #Registry username
    password:  #Registry password
    ssl: true  #Repository with SSL set or not
online: false   #Online installation?
language: RU_sv
timezone: "Europe/Moscow"
bip: 10.0.14.1/24   #Management IP address of the Docker's default network
fip: 10.0.15.1/24   #Fixed network address allocated for SV Monitor containers, 
facilitating management and access
#Component port configuration
components:
nginx:
    portMapping: {8081: 8080}
#
# ops_agent:
#   portMapping: {9071: 9070}
#
# skywalking_oap:
#   portMapping: {11800: 11800, 12800: 12800}
#
# elasticsearch:
#   portMapping: {9200: 9200}
#   password: elasticadmin
#
1.2.5 Отключить SELinux, чтобы он не прерывал установку SV Monitor:
sudo setenforce 0 && sudo sed -i
s/^SELINUX=enforcing/SELINUX=permissive/' /etc/selinux/config
1.2.6 Перейти в директорию /home/SiglaMonitor/finekey/bin и запустить установщик SV Monitor с помощью команды:
cd /home/SiglaMonitor/finekey/bin
sudo ./finekey
При успешной установке SV Monitor должно появиться сообщение:
Развернуть ment success. The access adress is:
[http://*IP_APP_SERVER*:8081/ops/decision]. bye~
1.2.7 После чего можно выполнить инициализацию системы и создать учетную запись администратора. Для этого необходимо перейти в браузер с доступом к серверу установки, по ссылке http:/*IP_APP_SERVER*:8081/ops/decision и в появившемся окне ввести логин и пароль, нажать ОК.
После регистрации администратора появится основная страница SV Monitor
1.2.8 Последним действием установки необходимо снять ограничение по установке внешних компонент (образов), для этого перейти в браузер по ссылке http://*IP_APP_SERVER*:8081/ops/decision/project/resource/limit?detect=false
Процесс инсталляции SV Monitor считается завершенным. Теперь можно приступать к инсталляции SV из образа Monitor.

Инсталляция SV из образа SV Monitor

В новой архитектуре системы SV установка и расширение инсталляции, например добавление новых нод в кластер реализуется при помощи интерфейса SV Monitor, а также средств автономной инсталляции (без непосредственного развертывания образов администратором в консоли). Развертывание образов выполняется из встроенного в SV Monitor репозитория, в составе которого уже находится SV актуальной версии платформы.
Для выполнения инсталляции SV необходимо выполнить следующие шаги:
2.1 Подключиться по SSH к виртуальной машине/серверу установке, на которой будет расположен SV и создать директорию, в которую будут загружен образы:
sudo mkdir /home/SiglaVision
sudo chmod 777 /home/SiglaVision
2.2 Перейти по ссылке http://*IP_APP_SERVER*:8081/ops/decision в браузере и аутентифицироваться под созданным в п. 1.2.7 пользователем администратором SV Monitor, чтобы выполнить инсталляцию SV.
2.3 После аутентификации вы перейдете на домашнюю страницу SV Monitor. Далее необходимо нажать на "Развернуть новый проект"
2.4 На данном этапе создания инстанса SV нужно выбрать конфигурацию BI приложения и его компоненты. При базовой инсталляции рекомендуются следующие настройки:
● Название проекта: SiglaVision
● Тип проекта: SiglaVision 2.0
● Кол-во сервисов приложения: 1 BI приложений + 1 BI движков
● Путь доступа: sigla
● Тип развертывания: Рабочее окружение
● Базовые компоненты:
○ Internal Gateway: Развернуть NginxStandalone
○ Сервис логов: Развернуть ElasticSearch
○ Файловый сервис: Развернуть MinIO
○ Внешняя конфигурационная БД: Развернуть Mysql8
○ Сервис состояния: Развернуть RedisStandalone
○ Служба хранения данных: Развернуть MinIO
2.5 Нажать “Далее”. В данном окне необходимо выбрать сервер, где будет установлен SV. Для добавления инстанса SV, нажать “Добавить узел”.
2.6 Следующим шагом необходимо узнать IP сервера, где должен быть установлен SV - подключиться по SSH к среде, на которой расположен SV Monitor и ввести команду:
docker ps
Найти IP-адрес, к которому прикрепляется SV Monitor
2.7 Вернуться обратно в браузер с окном конфигурации инстансов SV, ввести следующие настройки:
● Тип узла: Основной узел
● Хост: IP адрес, который был получен в предыдущем шаге
● Порт: 22
● Имя пользователя: *SSH_app_username*
● Способ проверки: Пароль
● Пароль: *SSH_app_password*
● Путь монтирования: /home/SiglaVision/data
По завершению заполнения нажать “Проверить подключение”
2.8 В случае успешного подключения узел SV отобразится в списке создания нового проекта. После чего можно нажать “Далее”. Здесь необходимо проверить список развертываемых компонентов и перераспределить порты в разделе “Пользовательское развертывание”. Важно отметить, что при наличие кастомных компонент необходимо задать актуальные учетные данные для авторизации под username, отличными от root.
2.9 Для nginx обязательно скорректировать порт 8082, для сервиса bi-web указать порт 8085, который внутри контейнера компонента будет распознаваться как 8080.
Остальные порты, в случае возникновения конфликтов (из-за того, что уже занимают другие компоненты), можно выбрать произвольно, рекомендуется добавлять +1 к значению порта для каждого следующего компонента в рамках доступного диапазона свободных портов.
2.10 Далее нажать “Начать проверку”, так начнется процесс проверки соответствия системным требованиям, а также совместимости вашей системы с SV. Процесс проверки может занять до 5 минут. По результатам проверки отобразится окно, что система прошла проверку и готова к развертыванию SV.
После чего, необходимо нажать на “Начать развертывание” для запуска процесса установки. В случае успеха будет отобразится сообщение “Проект успешно установлен”.
2.11 По завершению инсталляции, проект SV будет доступен для взаимодействия в разделе мониторинга “Управление проектами”. Ссылка на SiglaVision будет иметь следующий вид http://IP:port/sigla/decision
Процесс инсталляции SiglaVision считается завершенным.